<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>DeltaCoverageCalculator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../target/site/apidocs/org/apache/maven/plugin/deltacoverage/DeltaCoverageCalculator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.deltacoverage;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.util.List;
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.change.ClassChange;
<a name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.change.LineChange;
<a name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.AggregateCoverage;
<a name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.ClassCoverage;
<a name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.CoverageReportReader;
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.LineCoverage;
<a name="12" href="#12">12</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.MethodCoverage;
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.ModuleCoverage;
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.PackageCoverage;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.scm.CVSExecutor;
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.scm.SCMExecutor;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment">/**</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * Evaluates the delta coverage based on actual coverage and changes in source code.</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * </em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * @author Abhijeet_Kesarkar</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> *</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> */</em>
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/DeltaCoverageCalculator.html">DeltaCoverageCalculator</a> {
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">	 * Calculates delta coverage. Creates an instance of {@link ModuleCoverage} and populates it</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment">	 * with information from actual coverage, but only for lines changed. Re-calculates the </em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment">	 * coverage details, i.e. line rate and branch rate, based on this delta coverage information.</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">	 * @param actualCoverage as reported by existing coverage report using {@link CoverageReportReader}</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">	 * @param changes as extracted from SCM by {@link SCMExecutor} like {@link CVSExecutor}</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">	 * @return {@link ModuleCoverage} instance indicating delta coverage</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="37" href="#37">37</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a> calculateDeltaCoverage(<a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a> actualCoverage, List&lt;ClassChange&gt; changes) {
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  		ModuleCoverage deltaCoverage = createDeltaCoverage(actualCoverage, changes);
<a name="40" href="#40">40</a>  		evaluateCoverageRate(deltaCoverage);
<a name="41" href="#41">41</a>  		<strong class="jxr_keyword">return</strong> deltaCoverage;
<a name="42" href="#42">42</a>  	}
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 * Calculates the line rate and branch rate at module, package, class and method level based</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">	 * on the line hits and branch hits for the delta code.</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">	 * @param deltaCoverage {@link ModuleCoverage} instance indicating the delta coverage</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="50" href="#50">50</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> evaluateCoverageRate(<a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a> deltaCoverage) {
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>  		List&lt;LineCoverage&gt; moduleLines = <strong class="jxr_keyword">new</strong> ArrayList&lt;LineCoverage&gt;();
<a name="53" href="#53">53</a>  		<strong class="jxr_keyword">for</strong> (PackageCoverage packageCoverage : deltaCoverage.getPackages()) {
<a name="54" href="#54">54</a>  			List&lt;LineCoverage&gt; packageLines = <strong class="jxr_keyword">new</strong> ArrayList&lt;LineCoverage&gt;();
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>  			<strong class="jxr_keyword">for</strong> (ClassCoverage classCoverage : packageCoverage.getClasses()) {
<a name="57" href="#57">57</a>  				<strong class="jxr_keyword">for</strong> (MethodCoverage methodCoverage : classCoverage.getMethods()) {
<a name="58" href="#58">58</a>  					setLineRate(methodCoverage.getLines(), methodCoverage);
<a name="59" href="#59">59</a>  					setBranchRate(methodCoverage.getLines(), methodCoverage);
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>  				}
<a name="62" href="#62">62</a>  				setLineRate(classCoverage.getLines(), classCoverage);
<a name="63" href="#63">63</a>  				setBranchRate(classCoverage.getLines(), classCoverage);
<a name="64" href="#64">64</a>  				packageLines.addAll(classCoverage.getLines());
<a name="65" href="#65">65</a>  			}
<a name="66" href="#66">66</a>  			setLineRate(packageLines, packageCoverage);
<a name="67" href="#67">67</a>  			setBranchRate(packageLines, packageCoverage);
<a name="68" href="#68">68</a>  			moduleLines.addAll(packageLines);
<a name="69" href="#69">69</a>  		}
<a name="70" href="#70">70</a>  		setLineRate(moduleLines, deltaCoverage);
<a name="71" href="#71">71</a>  		setBranchRate(moduleLines, deltaCoverage);
<a name="72" href="#72">72</a>  	}
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">	 * Calculates lineRate for specified lines, and sets the same in the coverage instance.</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">	 * The coverage instance could be a method or a class or a package or a module coverage instance.</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">	 * @param lines list of {@link LineCoverage} </em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">	 * @param coverage {@link MethodCoverage} or {@link ClassCoverage} or {@link PackageCoverage} or {@link ModuleCoverage} instance</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="81" href="#81">81</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setLineRate(List&lt;LineCoverage&gt; lines, <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/AggregateCoverage.html">AggregateCoverage</a> coverage) {
<a name="82" href="#82">82</a>  		<strong class="jxr_keyword">double</strong> lineRate = -1.0;
<a name="83" href="#83">83</a>  		<strong class="jxr_keyword">int</strong> lineHit = 0;
<a name="84" href="#84">84</a>  		<strong class="jxr_keyword">for</strong> (LineCoverage lineCoverage : lines) {
<a name="85" href="#85">85</a>  			<strong class="jxr_keyword">if</strong> (lineCoverage.getHits() &gt; 0) {
<a name="86" href="#86">86</a>  				lineHit++;
<a name="87" href="#87">87</a>  			}
<a name="88" href="#88">88</a>  		}
<a name="89" href="#89">89</a>  		<strong class="jxr_keyword">if</strong> (lines.size() &gt; 0) {
<a name="90" href="#90">90</a>  			lineRate = (<strong class="jxr_keyword">double</strong>) lineHit / lines.size();
<a name="91" href="#91">91</a>  		}
<a name="92" href="#92">92</a>  		coverage.setLineRate(lineRate);
<a name="93" href="#93">93</a>  		coverage.setHitLines(lineHit);
<a name="94" href="#94">94</a>  		coverage.setTotalLines(lines.size());
<a name="95" href="#95">95</a>  	}
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">	 * Calculates branchRate for specified lines, and sets the same in the coverage instance.</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">	 * The coverage instance could be a method or a class or a package or a module coverage instance.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">	 * </em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">	 * @param lines list of {@link LineCoverage} </em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">	 * @param coverage {@link MethodCoverage} or {@link ClassCoverage} or {@link PackageCoverage} or {@link ModuleCoverage} instance</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">	 */</em>
<a name="104" href="#104">104</a> 	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setBranchRate(List&lt;LineCoverage&gt; lines, <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/AggregateCoverage.html">AggregateCoverage</a> coverage) {
<a name="105" href="#105">105</a> 		<strong class="jxr_keyword">double</strong> branchRate = -1.0;
<a name="106" href="#106">106</a> 		List&lt;String&gt; conditionCoverages = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
<a name="107" href="#107">107</a> 		<strong class="jxr_keyword">for</strong> (LineCoverage lineCoverage : lines) {
<a name="108" href="#108">108</a> 			<strong class="jxr_keyword">if</strong> (lineCoverage.isBranch()) {
<a name="109" href="#109">109</a> 				conditionCoverages.add(lineCoverage.getConditionCoverage());
<a name="110" href="#110">110</a> 			}
<a name="111" href="#111">111</a> 		}
<a name="112" href="#112">112</a> 		<strong class="jxr_keyword">if</strong> (conditionCoverages.size() &gt; 0) {
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a> 			<strong class="jxr_keyword">int</strong> numerator = 0;
<a name="115" href="#115">115</a> 			<strong class="jxr_keyword">int</strong> denominator = 0;
<a name="116" href="#116">116</a> 			<strong class="jxr_keyword">for</strong> (String conditionCoverage : conditionCoverages) {
<a name="117" href="#117">117</a> 				numerator += Integer.valueOf(conditionCoverage.split(<span class="jxr_string">"[&#92;&#92;(&#92;&#92;)]"</span>)[1].split(<span class="jxr_string">"/"</span>)[0]);
<a name="118" href="#118">118</a> 				denominator += Integer.valueOf(conditionCoverage.split(<span class="jxr_string">"[&#92;&#92;(&#92;&#92;)]"</span>)[1].split(<span class="jxr_string">"/"</span>)[1]);
<a name="119" href="#119">119</a> 			}
<a name="120" href="#120">120</a> 			branchRate = (<strong class="jxr_keyword">double</strong>) numerator / denominator;
<a name="121" href="#121">121</a> 			coverage.setHitBranches(numerator);
<a name="122" href="#122">122</a> 			coverage.setTotalBranches(denominator);
<a name="123" href="#123">123</a> 		}
<a name="124" href="#124">124</a> 		coverage.setBranchRate(branchRate);
<a name="125" href="#125">125</a> 	}
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">	 * Creates {@link ModuleCoverage} instance indicating the delta coverage tree.</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">	 * For each line change in the give list of {@link ClassChange}, builds the coverage tree </em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">	 * and populates the leaf nodes (lines) from the values from actual coverage.</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">	 * </em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">	 * @param actualCoverage {@link ModuleCoverage} instance indicating actual coverage</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">	 * @param changes list of {@link ClassChange}</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">	 * @return</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">	 */</em>
<a name="136" href="#136">136</a> 	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a> createDeltaCoverage(<a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a> actualCoverage, List&lt;ClassChange&gt; changes) {
<a name="137" href="#137">137</a> 		ModuleCoverage deltaCoverage = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a>();
<a name="138" href="#138">138</a> 		deltaCoverage.setVersion(actualCoverage.getVersion());
<a name="139" href="#139">139</a> 		deltaCoverage.setSources(actualCoverage.getSources());
<a name="140" href="#140">140</a> 		<strong class="jxr_keyword">for</strong> (ClassChange change : changes) {
<a name="141" href="#141">141</a> 			String packageName = getPackageName(change);
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a> 			ClassCoverage actualClassCoverage = <strong class="jxr_keyword">null</strong>;
<a name="144" href="#144">144</a> 			PackageCoverage actualPackageCoverage = actualCoverage.getPackage(packageName);
<a name="145" href="#145">145</a> 			<strong class="jxr_keyword">if</strong> (actualPackageCoverage != <strong class="jxr_keyword">null</strong>) {
<a name="146" href="#146">146</a> 				actualClassCoverage = actualPackageCoverage.getClass(change.getName());
<a name="147" href="#147">147</a> 			}
<a name="148" href="#148">148</a> 			<strong class="jxr_keyword">if</strong> (actualClassCoverage != <strong class="jxr_keyword">null</strong>) {
<a name="149" href="#149">149</a> 				ClassCoverage deltaClassCoverage = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/ClassCoverage.html">ClassCoverage</a>();
<a name="150" href="#150">150</a> 				deltaClassCoverage.setFilename(change.getFilename());
<a name="151" href="#151">151</a> 				deltaClassCoverage.setName(change.getName());
<a name="152" href="#152">152</a> 				<strong class="jxr_keyword">for</strong> (LineChange lineChange : change.getLines()) {
<a name="153" href="#153">153</a> 					<strong class="jxr_keyword">int</strong> number = lineChange.getLineNumber();
<a name="154" href="#154">154</a> 					LineCoverage lineCoverage = actualClassCoverage.getLine(number);
<a name="155" href="#155">155</a> 					<strong class="jxr_keyword">if</strong> (lineCoverage != <strong class="jxr_keyword">null</strong>) {
<a name="156" href="#156">156</a> 						lineCoverage.setValue(lineChange.getValue());
<a name="157" href="#157">157</a> 						deltaClassCoverage.addLine(lineCoverage);
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a> 						MethodCoverage actualMethodCoverage = actualClassCoverage.getMethod(number);
<a name="160" href="#160">160</a> 						<strong class="jxr_keyword">if</strong> (actualMethodCoverage != <strong class="jxr_keyword">null</strong>) {
<a name="161" href="#161">161</a> 							MethodCoverage deltaMethodCoverage = deltaClassCoverage.getMethod(actualMethodCoverage.getName(), actualMethodCoverage.getSignature());
<a name="162" href="#162">162</a> 							<strong class="jxr_keyword">if</strong> (deltaMethodCoverage == <strong class="jxr_keyword">null</strong>) {
<a name="163" href="#163">163</a> 								deltaMethodCoverage = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/MethodCoverage.html">MethodCoverage</a>();
<a name="164" href="#164">164</a> 								deltaMethodCoverage.setName(actualMethodCoverage.getName());
<a name="165" href="#165">165</a> 								deltaMethodCoverage.setSignature(actualMethodCoverage.getSignature());
<a name="166" href="#166">166</a> 								deltaClassCoverage.addMethod(deltaMethodCoverage);
<a name="167" href="#167">167</a> 							}
<a name="168" href="#168">168</a> 							deltaMethodCoverage.addLine(lineCoverage);
<a name="169" href="#169">169</a> 						}
<a name="170" href="#170">170</a> 					}
<a name="171" href="#171">171</a> 				}
<a name="172" href="#172">172</a> 
<a name="173" href="#173">173</a> 				<strong class="jxr_keyword">if</strong> (deltaClassCoverage.getLines() != <strong class="jxr_keyword">null</strong> &amp;&amp; deltaClassCoverage.getLines().size() &gt; 0) {
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a> 					PackageCoverage deltaPackageCoverage = deltaCoverage.getPackage(packageName);
<a name="176" href="#176">176</a> 					<strong class="jxr_keyword">if</strong> (deltaPackageCoverage == <strong class="jxr_keyword">null</strong>) {
<a name="177" href="#177">177</a> 						deltaPackageCoverage = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/deltacoverage/coverage/PackageCoverage.html">PackageCoverage</a>();
<a name="178" href="#178">178</a> 						deltaPackageCoverage.setName(packageName);
<a name="179" href="#179">179</a> 						deltaCoverage.addPackage(deltaPackageCoverage);
<a name="180" href="#180">180</a> 					}
<a name="181" href="#181">181</a> 					deltaPackageCoverage.addClass(deltaClassCoverage);
<a name="182" href="#182">182</a> 				}
<a name="183" href="#183">183</a> 			}
<a name="184" href="#184">184</a> 		}
<a name="185" href="#185">185</a> 		<strong class="jxr_keyword">return</strong> deltaCoverage;
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a> 	}
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">	 * Retrieves package name for the given class change.</em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">	 * </em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">	 * @param change {@link ClassChange}</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">	 * @return package name</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">	 */</em>
<a name="195" href="#195">195</a> 	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getPackageName(<a href="../../../../../org/apache/maven/plugin/deltacoverage/change/ClassChange.html">ClassChange</a> change) {
<a name="196" href="#196">196</a> 		String packageName = change.getName();
<a name="197" href="#197">197</a> 		<strong class="jxr_keyword">int</strong> index = change.getName().lastIndexOf('.');
<a name="198" href="#198">198</a> 		<strong class="jxr_keyword">if</strong>( index != -1 )
<a name="199" href="#199">199</a> 		{
<a name="200" href="#200">200</a> 			packageName = change.getName().substring(0, index);
<a name="201" href="#201">201</a> 		}
<a name="202" href="#202">202</a> 		<strong class="jxr_keyword">return</strong> packageName;
<a name="203" href="#203">203</a> 	}
<a name="204" href="#204">204</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

